home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dsbgvd.z / dsbgvd
Encoding:
Text File  |  2002-10-03  |  8.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DSBGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a real generalized symmetric-definite banded eigenproblem, of the form
  11.      A*x=(lambda)*B*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE DSBGVD( JOBZ, UPLO, N, KA, KB, AB, LDAB, BB, LDBB, W, Z, LDZ,
  15.                         WORK, LWORK, IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, KA, KB, LDAB, LDBB, LDZ, LIWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          DOUBLE         PRECISION AB( LDAB, * ), BB( LDBB, * ), W( * ), WORK(
  24.                         * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      DSBGVD computes all the eigenvalues, and optionally, the eigenvectors of
  41.      a real generalized symmetric-definite banded eigenproblem, of the form
  42.      A*x=(lambda)*B*x. Here A and B are assumed to be symmetric and banded,
  43.      and B is also positive definite.  If eigenvectors are desired, it uses a
  44.      divide and conquer algorithm.
  45.  
  46.      The divide and conquer algorithm makes very mild assumptions about
  47.      floating point arithmetic. It will work on machines with a guard digit in
  48.      add/subtract, or on those binary machines without guard digits which
  49.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  50.      conceivably fail on hexadecimal or decimal machines without guard digits,
  51.      but we know of none.
  52.  
  53.  
  54. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  55.      JOBZ    (input) CHARACTER*1
  56.              = 'N':  Compute eigenvalues only;
  57.              = 'V':  Compute eigenvalues and eigenvectors.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangles of A and B are stored;
  76.              = 'L':  Lower triangles of A and B are stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrices A and B.  N >= 0.
  80.  
  81.      KA      (input) INTEGER
  82.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  83.              the number of subdiagonals if UPLO = 'L'.  KA >= 0.
  84.  
  85.      KB      (input) INTEGER
  86.              The number of superdiagonals of the matrix B if UPLO = 'U', or
  87.              the number of subdiagonals if UPLO = 'L'.  KB >= 0.
  88.  
  89.      AB      (input/output) DOUBLE PRECISION array, dimension (LDAB, N)
  90.              On entry, the upper or lower triangle of the symmetric band
  91.              matrix A, stored in the first ka+1 rows of the array.  The j-th
  92.              column of A is stored in the j-th column of the array AB as
  93.              follows:  if UPLO = 'U', AB(ka+1+i-j,j) = A(i,j) for max(1,j-
  94.              ka)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  95.              j<=i<=min(n,j+ka).
  96.  
  97.              On exit, the contents of AB are destroyed.
  98.  
  99.      LDAB    (input) INTEGER
  100.              The leading dimension of the array AB.  LDAB >= KA+1.
  101.  
  102.      BB      (input/output) DOUBLE PRECISION array, dimension (LDBB, N)
  103.              On entry, the upper or lower triangle of the symmetric band
  104.              matrix B, stored in the first kb+1 rows of the array.  The j-th
  105.              column of B is stored in the j-th column of the array BB as
  106.              follows:  if UPLO = 'U', BB(ka+1+i-j,j) = B(i,j) for max(1,j-
  107.              kb)<=i<=j; if UPLO = 'L', BB(1+i-j,j)    = B(i,j) for
  108.              j<=i<=min(n,j+kb).
  109.  
  110.              On exit, the factor S from the split Cholesky factorization B =
  111.              S**T*S, as returned by DPBSTF.
  112.  
  113.      LDBB    (input) INTEGER
  114.              The leading dimension of the array BB.  LDBB >= KB+1.
  115.  
  116.      W       (output) DOUBLE PRECISION array, dimension (N)
  117.              If INFO = 0, the eigenvalues in ascending order.
  118.  
  119.      Z       (output) DOUBLE PRECISION array, dimension (LDZ, N)
  120.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  121.              eigenvectors, with the i-th column of Z holding the eigenvector
  122.              associated with W(i).  The eigenvectors are normalized so
  123.              Z**T*B*Z = I.  If JOBZ = 'N', then Z is not referenced.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSBBBBGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDZ     (input) INTEGER
  141.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  142.              'V', LDZ >= max(1,N).
  143.  
  144.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  145.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  146.  
  147.      LWORK   (input) INTEGER
  148.              The dimension of the array WORK.  If N <= 1,               LWORK
  149.              >= 1.  If JOBZ = 'N' and N > 1, LWORK >= 3*N.  If JOBZ = 'V' and
  150.              N > 1, LWORK >= 1 + 5*N + 2*N**2.
  151.  
  152.              If LWORK = -1, then a workspace query is assumed; the routine
  153.              only calculates the optimal size of the WORK array, returns this
  154.              value as the first entry of the WORK array, and no error message
  155.              related to LWORK is issued by XERBLA.
  156.  
  157.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  158.              On exit, if LIWORK > 0, IWORK(1) returns the optimal LIWORK.
  159.  
  160.      LIWORK  (input) INTEGER
  161.              The dimension of the array IWORK.  If JOBZ  = 'N' or N <= 1,
  162.              LIWORK >= 1.  If JOBZ  = 'V' and N > 1, LIWORK >= 3 + 5*N.
  163.  
  164.              If LIWORK = -1, then a workspace query is assumed; the routine
  165.              only calculates the optimal size of the IWORK array, returns this
  166.              value as the first entry of the IWORK array, and no error message
  167.              related to LIWORK is issued by XERBLA.
  168.  
  169.      INFO    (output) INTEGER
  170.              = 0:  successful exit
  171.              < 0:  if INFO = -i, the i-th argument had an illegal value
  172.              > 0:  if INFO = i, and i is:
  173.              <= N:  the algorithm failed to converge:  i off-diagonal elements
  174.              of an intermediate tridiagonal form did not converge to zero; >
  175.              N:   if INFO = N + i, for 1 <= i <= N, then DPBSTF
  176.              returned INFO = i: B is not positive definite.  The factorization
  177.              of B could not be completed and no eigenvalues or eigenvectors
  178.              were computed.
  179.  
  180. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  181.      Based on contributions by
  182.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  183.  
  184.  
  185. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  186.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  187.  
  188.      This man page is available only online.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.